Sendbird UIKit/com.sendbird.uikit.vm/ChannelViewModel

ChannelViewModel

open class ChannelViewModel : BaseMessageListViewModel

ViewModel preparing and managing data related with the list of messages in a channel since 3.0.0

Constructors

ChannelViewModel

open fun ChannelViewModel(@NonNull channelUrl: String, @Nullable messageListParams: MessageListParams)

Constructor

Types

ChannelMessageData

open class ChannelMessageData

Class that holds message data in a channel.

Functions

buildMessageList

@UiThread

@NonNull

open fun buildMessageList(): List<BaseMessage>

Processes a list of messages to be passed to the view.

createMessageListParams

@NonNull

open fun createMessageListParams(): MessageListParams

Creates params for the message list when loading the message list.

deleteMessage

open fun deleteMessage(@NonNull message: BaseMessage, @Nullable handler: OnCompleteHandler)

Deletes a message.

getHugeGapDetected

@NonNull

open fun getHugeGapDetected(): LiveData<Boolean>

Returns LiveData that can be observed if huge gaps are detected within the collection this view model managed.

getMessageById

@Nullable

open fun getMessageById(messageId: Long): BaseMessage

Retrieves message that matches messageId from the message list which this view model manages.

getMessageLoadState

@NonNull

open fun getMessageLoadState(): LiveData<MessageLoadState>

Returns LiveData that can be observed for the state of loading messages.

getMessagesByCreatedAt

@NonNull

open fun getMessagesByCreatedAt(createdAt: Long): List<BaseMessage>

Retrieves messages created at createdAt from the message list which this view model manages.

getStartingPoint

open fun getStartingPoint(): Long

Returns the timestamp that is the starting point when the message list is fetched initially.

getStatusFrame

@NonNull

open fun getStatusFrame(): LiveData<StatusFrameView.Status>

Returns LiveData that can be observed for the status of the result of fetching the message list.

getTypingMembers

@NonNull

open fun getTypingMembers(): LiveData<List<User>>

Returns LiveData that can be observed for members who are typing in the channel associated with this view model.

hasMessageById

open fun hasMessageById(messageId: Long): Boolean

Checks if the message with messageId is in the message list which this view model manages.

hasNext

open fun hasNext(): Boolean

Determine whether the data on the next page exists.

hasPrevious

open fun hasPrevious(): Boolean

Determine whether the data on the previous page exists.

loadInitial

@UiThread

open fun loadInitial(startingPoint: Long): Boolean

Requests the list of BaseMessages for the first time.

loadNext

@WorkerThread

@NonNull

open fun loadNext(): List<BaseMessage>

Requests the list of BaseMessages when the page goes to the next.

loadPrevious

@WorkerThread

@NonNull

open fun loadPrevious(): List<BaseMessage>

Requests the list of BaseMessages when the page goes to the previous.

onChannelDeleted

@NonNull

open fun onChannelDeleted(): LiveData<String>

Returns LiveData that can be observed if the channel has been deleted.

onChannelUpdated

@NonNull

open fun onChannelUpdated(): LiveData<GroupChannel>

Returns LiveData that can be observed if the channel has been updated.

onCleared

protected open fun onCleared()

onFeedbackDeleted

@NonNull

open fun onFeedbackDeleted(): LiveData<Pair<BaseMessage, SendbirdException>>

Returns LiveData that can be observed for the result of deleting feedback.

onFeedbackSubmitted

open fun onFeedbackSubmitted(): LiveData<Pair<BaseMessage, SendbirdException>>

Returns LiveData that can be observed for the result of submitting feedback.

onFeedbackUpdated

@NonNull

open fun onFeedbackUpdated(): LiveData<Pair<BaseMessage, SendbirdException>>

Returns LiveData that can be observed for the result of updating feedback.

onMessagesDeleted

@NonNull

open fun onMessagesDeleted(): LiveData<List<BaseMessage>>

Returns LiveData that can be observed if the messages has been deleted in the collection this view model managed.

removeFeedback

open fun removeFeedback(@NonNull message: BaseMessage)

Removes feedback for the message.

setMessageCollectionHandler

open fun setMessageCollectionHandler(@Nullable handler: MessageCollectionHandler)

Registers a handler for the message collection managed by this view model.

submitFeedback

open fun submitFeedback( @NonNull message: BaseMessage, @NonNull rating: FeedbackRating, @Nullable comment: String)

Submits feedback for the message.

Properties

messageListParams

@Nullable

@get:Nullable

open val messageListParams: MessageListParams